package com.example.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Swagger API 文档配置
 * 使用 SpringDoc OpenAPI 3.0
 * 
 * @author Simon
 * @since 2025-09-10
 */
@Configuration
public class SwaggerConfig {

    private static final String SECURITY_SCHEME_NAME = "bearerAuth";

    /**
     * 配置 OpenAPI 文档信息和安全设置
     */
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("学生管理系统 API")
                        .description("Spring Boot 学习项目 - 学生管理系统的 RESTful API 文档\n\n" +
                                   "🔐 **认证说明：**\n" +
                                   "- 大部分接口需要 JWT Token 认证\n" +
                                   "- 请先调用 `/api/admin/login` 获取 Token\n" +
                                   "- 在右上角 'Authorize' 按钮中输入 Token\n" +
                                   "- Token 格式：直接输入返回的 token 值即可\n\n" +
                                   "🚀 **快速开始：**\n" +
                                   "1. 使用管理员账号登录获取 Token\n" +
                                   "2. 点击 'Authorize' 按钮输入 Token\n" +
                                   "3. 现在可以访问受保护的接口了")
                        .version("v1.0.0")
                        .contact(new Contact()
                                .name("Simon")
                                .email("blockman1024@gmail.com")
                                .url("https://github.com/vsiryxm"))
                        .license(new License()
                                .name("MIT License")
                                .url("https://opensource.org/licenses/MIT")))
                // 配置安全方案（不添加全局安全要求，让每个接口单独配置）
                .components(new Components()
                        .addSecuritySchemes(SECURITY_SCHEME_NAME, createJWTScheme()));
    }

    /**
     * 创建 JWT Bearer Token 认证方案
     */
    private SecurityScheme createJWTScheme() {
        return new SecurityScheme()
                .type(SecurityScheme.Type.HTTP)
                .scheme("bearer")
                .bearerFormat("JWT")
                .name(SECURITY_SCHEME_NAME)
                .description("请输入 JWT Token（无需添加 'Bearer ' 前缀）")
                .in(SecurityScheme.In.HEADER);
    }
}
